Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable and update endpoint for telemetry for longevity tests #2824

Merged
merged 2 commits into from
Dec 4, 2024

Conversation

salonichf5
Copy link
Contributor

@salonichf5 salonichf5 commented Nov 26, 2024

Proposed changes

We want to report telemetry when running longevity tests to the development endpoint.

Problem: Users want to get telemetry reports when running longevity tests to simulate a live environment.

Solution: To provide live telemetry reports when running longevity tests, we have enabled telemetry for the test when label is longevity and updated the workflow that creates the binary for release to update the TELEMETRY_ENDPOINT to the dev endpoint.

Note: I will be updating the binary building workflow to be triggered on a push to release branch. I tested it on the condition of pull_request to verify variables are set properly.

Testing: Manual testing using Github actions and running longevity tests.

Screenshot 2024-11-27 at 11 07 16 AM

Running make start-longevity-test

make start-longevity-test
CI=false ./scripts/run-tests-gcp-vm.sh
.
.
.
 Installing NGF with command: helm install --debug ngf-longevity /home/username/nginx-gateway-fabric/charts/nginx-gateway-fabric --create-namespace --namespace nginx-gateway --wait --set nginxGateway.snippetsFilters.enable=true --set nginxGateway.image.repository=gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/nginx-gateway-fabric --set nginxGateway.image.tag=release-1.5-rc --set nginxGateway.image.pullPolicy=Always --set nginx.image.repository=gcr.io/f5-gcs-7899-ptg-ingrss-ctlr/nginx-gateway-fabric/nginx-oss --set nginx.image.tag=release-1.5-rc --set nginx.image.pullPolicy=Always --set nginx.plus=true --set service.type=LoadBalancer --set service.annotations.networking\.gke\.io\/load-balancer-type=Internal --set nginxGateway.productTelemetry.enable=false --set nginxGateway.productTelemetry.enable=true --set nginxGateway.config.logging.level=debug

Product Telemetry set to true

--set nginxGateway.productTelemetry.enable=true 

Please focus on (optional): If you any specific areas where you would like reviewers to focus their attention or provide
specific feedback, add them here.

Closes #1781

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

Release notes

If this PR introduces a change that affects users and needs to be mentioned in the release notes,
please add a brief note that summarizes the change.


@salonichf5 salonichf5 requested a review from a team as a code owner November 26, 2024 23:48
@salonichf5 salonichf5 marked this pull request as draft November 26, 2024 23:48
@github-actions github-actions bot added the tests Pull requests that update tests label Nov 26, 2024
Copy link

codecov bot commented Nov 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.86%. Comparing base (73afa15) to head (0c92abb).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2824   +/-   ##
=======================================
  Coverage   89.86%   89.86%           
=======================================
  Files         107      107           
  Lines       10997    10997           
  Branches       50       50           
=======================================
  Hits         9883     9883           
  Misses       1054     1054           
  Partials       60       60           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@salonichf5 salonichf5 force-pushed the tests/telemetry-longevity branch 10 times, most recently from 09b7383 to 9d55657 Compare November 27, 2024 21:01
@salonichf5 salonichf5 marked this pull request as ready for review November 27, 2024 21:01
Copy link
Collaborator

@sjberman sjberman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll defer to @lucacome to make sure this logic is correct. It looks like we have to enable building with the dev endpoint for all pushes to the release branch in order build the -rc images with it, which we use for the longevity tests. But this shouldn't be an issue because when we tag for a release, it'll fail the condition and use the prod endpoint instead.

.github/workflows/ci.yml Outdated Show resolved Hide resolved
tests/framework/ngf.go Outdated Show resolved Hide resolved
@salonichf5 salonichf5 changed the title TEST: Enable and update endpoint for telemetry for longevity tests Enable and update endpoint for telemetry for longevity tests Nov 27, 2024
.github/workflows/ci.yml Outdated Show resolved Hide resolved
Copy link
Contributor

@kate-osborn kate-osborn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

test code changes LGTM

.github/workflows/ci.yml Outdated Show resolved Hide resolved
@salonichf5 salonichf5 force-pushed the tests/telemetry-longevity branch 2 times, most recently from 1f3c51e to 18756bc Compare December 4, 2024 04:34
@salonichf5 salonichf5 force-pushed the tests/telemetry-longevity branch from 18756bc to 0c92abb Compare December 4, 2024 20:20
@salonichf5 salonichf5 enabled auto-merge (squash) December 4, 2024 20:21
@salonichf5 salonichf5 merged commit 618e37f into main Dec 4, 2024
40 checks passed
@salonichf5 salonichf5 deleted the tests/telemetry-longevity branch December 4, 2024 20:31
miledxz added a commit to miledxz/nginx-gateway-fabric that referenced this pull request Jan 14, 2025
)

Enable and update endpoint for telemetry for longevity tests

Problem: Users want to get telemetry reports when running longevity tests to simulate a live environment.

Solution: To provide live telemetry reports when running longevity tests, we have enabled telemetry for the test when label is longevity and updated the workflow that creates the binary for release to update the TELEMETRY_ENDPOINT to the dev endpoint.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tests Pull requests that update tests
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Enable Telemetry during Longevity Test
4 participants